Get Channels List
Overview
The table below provides key details about the GET method for retrieving a channel list.
| Get Channels List | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/v2/projectId/channels |
| Headers | Authorization |
| Parameters | healthStatusId, liveStatusId, search, order, insertedDate, page, take, projectId |
The description of the URL parameter is as follows:
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
| healthStatusId URL Parameter | |
|---|---|
| URL Parameter Name | healthStatusId |
| Mandatory | No |
| Type | integer($int32) |
| Description | Health status unique id for the channel |
| liveStatusId URL Parameter | |
|---|---|
| URL Parameter Name | liveStatusId |
| Mandatory | No |
| Type | integer($int32) |
| Description | Live status unique id for the project. |
| search URL Parameter | |
|---|---|
| URL Parameter Name | search |
| Mandatory | No |
| Type | string |
| Description | Search for a specific channel |
| order URL Parameter | |
|---|---|
| URL Parameter Name | order |
| Mandatory | No |
| Type | string |
| Description | Specified the order position of the channel |
| insertedDate URL Parameter | |
|---|---|
| URL Parameter Name | insertedDate |
| Mandatory | No |
| Type | string($date-time) |
| Description | Date time |
| page URL Parameter | |
|---|---|
| URL Parameter Name | page |
| Mandatory | No |
| Type | integer($int32) |
| Description | Current page you want to receive |
| take URL Parameter | |
|---|---|
| URL Parameter Name | take |
| Mandatory | No |
| Type | integer($int32) |
| Description | Number of channels you want to receive |
Request Body
The body does not have body request
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"items": [
{
"publicId": "string",
"title": "string",
"logo": "string",
"healthStatus": "string",
"liveStatus": "string",
"inputType": "string",
"orderNumber": ""
}
]
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| publicId | string | Returns the public identifier of the channel |
| title | string | Returns the title of the channel |
| logo | string($binary) | Returns the URL for the channel's logo |
| healthStatus | string | Indicate the health status of the channel |
| liveStatus | string | Indicate the live status of the channel |
| inputType | string | Specifies input type of the channel |
| orderNumber | string | Returns order position of the channel |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed